<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::transport::struc::Struct_builder::Config Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport.html">transport</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport_1_1struc.html">struc</a></li><li class="navelem"><a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html">Struct_builder</a></li><li class="navelem"><a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html">Config</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::transport::struc::Struct_builder::Config Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Copy-ctible, copy-assignable, default-ctible type &ndash; informally, cheaply copyable and likely an <em>aggregate</em> <code>struct</code> &ndash; objects of which store data that <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> main ctor knows how to interpret as knobs controlling its behavior.  
 <a href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html">serializer.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ipc::transport::struc::Struct_builder::Config:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config__coll__graph.svg" width="343" height="131"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a6abb379e5758db2691bb80cad71d6fb9"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html#a6abb379e5758db2691bb80cad71d6fb9">Builder</a> = <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html">Struct_builder</a></td></tr>
<tr class="memdesc:a6abb379e5758db2691bb80cad71d6fb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias to containing <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a>. Useful for generic programming.  <a href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html#a6abb379e5758db2691bb80cad71d6fb9">More...</a><br /></td></tr>
<tr class="separator:a6abb379e5758db2691bb80cad71d6fb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab818ec0d61c6c797f27222acc5fc0038"><td class="memItemLeft" align="right" valign="top">flow::log::Logger&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html#ab818ec0d61c6c797f27222acc5fc0038">m_logger_ptr</a></td></tr>
<tr class="memdesc:ab818ec0d61c6c797f27222acc5fc0038"><td class="mdescLeft">&#160;</td><td class="mdescRight">First knob is typically the <code>Logger*</code> (null allowed) the <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> will use.  <a href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html#ab818ec0d61c6c797f27222acc5fc0038">More...</a><br /></td></tr>
<tr class="separator:ab818ec0d61c6c797f27222acc5fc0038"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a855ec0521ca4f2a2a841d2a25ee6f12a"><td class="memItemLeft" align="right" valign="top">Example_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html#a855ec0521ca4f2a2a841d2a25ee6f12a">m_example_struct</a></td></tr>
<tr class="memdesc:a855ec0521ca4f2a2a841d2a25ee6f12a"><td class="mdescLeft">&#160;</td><td class="mdescRight">An arbitrary, but cheaply-copyable in aggregate, set of knobs like (e.g.) this one follow.  <a href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html#a855ec0521ca4f2a2a841d2a25ee6f12a">More...</a><br /></td></tr>
<tr class="separator:a855ec0521ca4f2a2a841d2a25ee6f12a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a267bcfe82c950040af5089543227a57e"><td class="memItemLeft" align="right" valign="top">example_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html#a267bcfe82c950040af5089543227a57e">m_example_val</a></td></tr>
<tr class="memdesc:a267bcfe82c950040af5089543227a57e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Or like this one.  <a href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html#a267bcfe82c950040af5089543227a57e">More...</a><br /></td></tr>
<tr class="separator:a267bcfe82c950040af5089543227a57e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Copy-ctible, copy-assignable, default-ctible type &ndash; informally, cheaply copyable and likely an <em>aggregate</em> <code>struct</code> &ndash; objects of which store data that <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> main ctor knows how to interpret as knobs controlling its behavior. </p>
<p >While a plain-old-<code>struct</code> is a solid choice, a more complex API for a given <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> impl is conceivable. In general, the simpler to construct and query, but especially construct (ideally by aggregate initialization), the better. Cheap copyability is essential.</p>
<p >Internal <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> impl code will be querying the knobs; the user may be explicitly constructing <a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html" title="Copy-ctible, copy-assignable, default-ctible type – informally, cheaply copyable and likely an aggreg...">Config</a> and then constructing <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> repeatedly from that same <a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html" title="Copy-ctible, copy-assignable, default-ctible type – informally, cheaply copyable and likely an aggreg...">Config</a>. Most likely, however, various utilities (like Session_mv::heap_fixed_builder_config()) will return ready-made <code><a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html" title="Copy-ctible, copy-assignable, default-ctible type – informally, cheaply copyable and likely an aggreg...">Config</a></code>s without user's direct input.</p>
<p >As you can see, there are not many requirements: this sub-concept is essentially meant to be (usually) an aggregation of what would normally be individual ctor args to <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a>, a few little scalars at that. It <em>can</em> however conceivably feature ctors and more advanced behavior (while retaining cheap copyability).</p>
<p >While <a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html" title="Copy-ctible, copy-assignable, default-ctible type – informally, cheaply copyable and likely an aggreg...">Config</a> must default-ctible, <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> may stipulate that such an as-if-default-cted <a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html" title="Copy-ctible, copy-assignable, default-ctible type – informally, cheaply copyable and likely an aggreg...">Config</a> being passed to <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> ctor = undefined behavior or otherwise invalid. </p>

<p class="definition">Definition at line <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html#l00222">222</a> of file <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html">serializer.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a6abb379e5758db2691bb80cad71d6fb9" name="a6abb379e5758db2691bb80cad71d6fb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6abb379e5758db2691bb80cad71d6fb9">&#9670;&nbsp;</a></span>Builder</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html#a6abb379e5758db2691bb80cad71d6fb9">ipc::transport::struc::Struct_builder::Config::Builder</a> =  <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html">Struct_builder</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Alias to containing <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a>. Useful for generic programming. </p>

<p class="definition">Definition at line <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html#l00228">228</a> of file <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a855ec0521ca4f2a2a841d2a25ee6f12a" name="a855ec0521ca4f2a2a841d2a25ee6f12a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a855ec0521ca4f2a2a841d2a25ee6f12a">&#9670;&nbsp;</a></span>m_example_struct</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Example_type ipc::transport::struc::Struct_builder::Config::m_example_struct</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>An arbitrary, but cheaply-copyable in aggregate, set of knobs like (e.g.) this one follow. </p>

<p class="definition">Definition at line <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html#l00236">236</a> of file <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="a267bcfe82c950040af5089543227a57e" name="a267bcfe82c950040af5089543227a57e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a267bcfe82c950040af5089543227a57e">&#9670;&nbsp;</a></span>m_example_val</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">example_t ipc::transport::struc::Struct_builder::Config::m_example_val</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Or like this one. </p>

<p class="definition">Definition at line <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html#l00239">239</a> of file <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="ab818ec0d61c6c797f27222acc5fc0038" name="ab818ec0d61c6c797f27222acc5fc0038"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab818ec0d61c6c797f27222acc5fc0038">&#9670;&nbsp;</a></span>m_logger_ptr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">flow::log::Logger ipc::transport::struc::Struct_builder::Config::m_logger_ptr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>First knob is typically the <code>Logger*</code> (null allowed) the <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> will use. </p>

<p class="definition">Definition at line <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html#l00233">233</a> of file <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>transport/struc/<a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2serializer_8hpp_source.html">serializer.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
